<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html lang="en">
<head>
<title>Source code</title>
<link rel="stylesheet" type="text/css" href="../../../../../stylesheet.css" title="Style">
</head>
<body>
<div class="sourceContainer">
<pre><span class="sourceLineNo">001</span>/* ===========================================================<a name="line.1"></a>
<span class="sourceLineNo">002</span> * JFreeChart : a free chart library for the Java(tm) platform<a name="line.2"></a>
<span class="sourceLineNo">003</span> * ===========================================================<a name="line.3"></a>
<span class="sourceLineNo">004</span> *<a name="line.4"></a>
<span class="sourceLineNo">005</span> * (C) Copyright 2000-2011, by Object Refinery Limited and Contributors.<a name="line.5"></a>
<span class="sourceLineNo">006</span> *<a name="line.6"></a>
<span class="sourceLineNo">007</span> * Project Info:  http://www.jfree.org/jfreechart/index.html<a name="line.7"></a>
<span class="sourceLineNo">008</span> *<a name="line.8"></a>
<span class="sourceLineNo">009</span> * This library is free software; you can redistribute it and/or modify it<a name="line.9"></a>
<span class="sourceLineNo">010</span> * under the terms of the GNU Lesser General Public License as published by<a name="line.10"></a>
<span class="sourceLineNo">011</span> * the Free Software Foundation; either version 2.1 of the License, or<a name="line.11"></a>
<span class="sourceLineNo">012</span> * (at your option) any later version.<a name="line.12"></a>
<span class="sourceLineNo">013</span> *<a name="line.13"></a>
<span class="sourceLineNo">014</span> * This library is distributed in the hope that it will be useful, but<a name="line.14"></a>
<span class="sourceLineNo">015</span> * WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY<a name="line.15"></a>
<span class="sourceLineNo">016</span> * or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public<a name="line.16"></a>
<span class="sourceLineNo">017</span> * License for more details.<a name="line.17"></a>
<span class="sourceLineNo">018</span> *<a name="line.18"></a>
<span class="sourceLineNo">019</span> * You should have received a copy of the GNU Lesser General Public<a name="line.19"></a>
<span class="sourceLineNo">020</span> * License along with this library; if not, write to the Free Software<a name="line.20"></a>
<span class="sourceLineNo">021</span> * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301,<a name="line.21"></a>
<span class="sourceLineNo">022</span> * USA.<a name="line.22"></a>
<span class="sourceLineNo">023</span> *<a name="line.23"></a>
<span class="sourceLineNo">024</span> * [Oracle and Java are registered trademarks of Oracle and/or its affiliates. <a name="line.24"></a>
<span class="sourceLineNo">025</span> * Other names may be trademarks of their respective owners.]<a name="line.25"></a>
<span class="sourceLineNo">026</span> *<a name="line.26"></a>
<span class="sourceLineNo">027</span> * --------<a name="line.27"></a>
<span class="sourceLineNo">028</span> * Day.java<a name="line.28"></a>
<span class="sourceLineNo">029</span> * --------<a name="line.29"></a>
<span class="sourceLineNo">030</span> * (C) Copyright 2001-2009, by Object Refinery Limited.<a name="line.30"></a>
<span class="sourceLineNo">031</span> *<a name="line.31"></a>
<span class="sourceLineNo">032</span> * Original Author:  David Gilbert (for Object Refinery Limited);<a name="line.32"></a>
<span class="sourceLineNo">033</span> * Contributor(s):   -;<a name="line.33"></a>
<span class="sourceLineNo">034</span> *<a name="line.34"></a>
<span class="sourceLineNo">035</span> * Changes<a name="line.35"></a>
<span class="sourceLineNo">036</span> * -------<a name="line.36"></a>
<span class="sourceLineNo">037</span> * 11-Oct-2001 : Version 1 (DG);<a name="line.37"></a>
<span class="sourceLineNo">038</span> * 15-Nov-2001 : Updated Javadoc comments (DG);<a name="line.38"></a>
<span class="sourceLineNo">039</span> * 04-Dec-2001 : Added static method to parse a string into a Day object (DG);<a name="line.39"></a>
<span class="sourceLineNo">040</span> * 19-Dec-2001 : Added new constructor as suggested by Paul English (DG);<a name="line.40"></a>
<span class="sourceLineNo">041</span> * 29-Jan-2002 : Changed getDay() method to getSerialDate() (DG);<a name="line.41"></a>
<span class="sourceLineNo">042</span> * 26-Feb-2002 : Changed getStart(), getMiddle() and getEnd() methods to<a name="line.42"></a>
<span class="sourceLineNo">043</span> *               evaluate with reference to a particular time zone (DG);<a name="line.43"></a>
<span class="sourceLineNo">044</span> * 19-Mar-2002 : Changed the API for the TimePeriod classes (DG);<a name="line.44"></a>
<span class="sourceLineNo">045</span> * 29-May-2002 : Fixed bug in equals method (DG);<a name="line.45"></a>
<span class="sourceLineNo">046</span> * 24-Jun-2002 : Removed unnecessary imports (DG);<a name="line.46"></a>
<span class="sourceLineNo">047</span> * 10-Sep-2002 : Added getSerialIndex() method (DG);<a name="line.47"></a>
<span class="sourceLineNo">048</span> * 07-Oct-2002 : Fixed errors reported by Checkstyle (DG);<a name="line.48"></a>
<span class="sourceLineNo">049</span> * 10-Jan-2003 : Changed base class and method names (DG);<a name="line.49"></a>
<span class="sourceLineNo">050</span> * 13-Mar-2003 : Moved to com.jrefinery.data.time package, and implemented<a name="line.50"></a>
<span class="sourceLineNo">051</span> *               Serializable (DG);<a name="line.51"></a>
<span class="sourceLineNo">052</span> * 21-Oct-2003 : Added hashCode() method (DG);<a name="line.52"></a>
<span class="sourceLineNo">053</span> * 30-Sep-2004 : Replaced getTime().getTime() with getTimeInMillis() (DG);<a name="line.53"></a>
<span class="sourceLineNo">054</span> * 04-Nov-2004 : Reverted change of 30-Sep-2004, because it won't work for<a name="line.54"></a>
<span class="sourceLineNo">055</span> *               JDK 1.3 (DG);<a name="line.55"></a>
<span class="sourceLineNo">056</span> * ------------- JFREECHART 1.0.x ---------------------------------------------<a name="line.56"></a>
<span class="sourceLineNo">057</span> * 05-Oct-2006 : Updated API docs (DG);<a name="line.57"></a>
<span class="sourceLineNo">058</span> * 06-Oct-2006 : Refactored to cache first and last millisecond values (DG);<a name="line.58"></a>
<span class="sourceLineNo">059</span> * 16-Sep-2008 : Deprecated DEFAULT_TIME_ZONE (DG);<a name="line.59"></a>
<span class="sourceLineNo">060</span> * 02-Mar-2009 : Added new constructor with Locale (DG);<a name="line.60"></a>
<span class="sourceLineNo">061</span> *<a name="line.61"></a>
<span class="sourceLineNo">062</span> */<a name="line.62"></a>
<span class="sourceLineNo">063</span><a name="line.63"></a>
<span class="sourceLineNo">064</span>package org.jfree.data.time;<a name="line.64"></a>
<span class="sourceLineNo">065</span><a name="line.65"></a>
<span class="sourceLineNo">066</span>import java.io.Serializable;<a name="line.66"></a>
<span class="sourceLineNo">067</span>import java.text.DateFormat;<a name="line.67"></a>
<span class="sourceLineNo">068</span>import java.text.ParseException;<a name="line.68"></a>
<span class="sourceLineNo">069</span>import java.text.SimpleDateFormat;<a name="line.69"></a>
<span class="sourceLineNo">070</span>import java.util.Calendar;<a name="line.70"></a>
<span class="sourceLineNo">071</span>import java.util.Date;<a name="line.71"></a>
<span class="sourceLineNo">072</span>import java.util.Locale;<a name="line.72"></a>
<span class="sourceLineNo">073</span>import java.util.TimeZone;<a name="line.73"></a>
<span class="sourceLineNo">074</span><a name="line.74"></a>
<span class="sourceLineNo">075</span>import org.jfree.date.SerialDate;<a name="line.75"></a>
<span class="sourceLineNo">076</span><a name="line.76"></a>
<span class="sourceLineNo">077</span>/**<a name="line.77"></a>
<span class="sourceLineNo">078</span> * Represents a single day in the range 1-Jan-1900 to 31-Dec-9999.  This class<a name="line.78"></a>
<span class="sourceLineNo">079</span> * is immutable, which is a requirement for all {@link RegularTimePeriod}<a name="line.79"></a>
<span class="sourceLineNo">080</span> * subclasses.<a name="line.80"></a>
<span class="sourceLineNo">081</span> */<a name="line.81"></a>
<span class="sourceLineNo">082</span>public class Day extends RegularTimePeriod implements Serializable {<a name="line.82"></a>
<span class="sourceLineNo">083</span><a name="line.83"></a>
<span class="sourceLineNo">084</span>    /** For serialization. */<a name="line.84"></a>
<span class="sourceLineNo">085</span>    private static final long serialVersionUID = -7082667380758962755L;<a name="line.85"></a>
<span class="sourceLineNo">086</span><a name="line.86"></a>
<span class="sourceLineNo">087</span>    /** A standard date formatter. */<a name="line.87"></a>
<span class="sourceLineNo">088</span>    protected static final DateFormat DATE_FORMAT<a name="line.88"></a>
<span class="sourceLineNo">089</span>        = new SimpleDateFormat("yyyy-MM-dd");<a name="line.89"></a>
<span class="sourceLineNo">090</span><a name="line.90"></a>
<span class="sourceLineNo">091</span>    /** A date formatter for the default locale. */<a name="line.91"></a>
<span class="sourceLineNo">092</span>    protected static final DateFormat<a name="line.92"></a>
<span class="sourceLineNo">093</span>        DATE_FORMAT_SHORT = DateFormat.getDateInstance(DateFormat.SHORT);<a name="line.93"></a>
<span class="sourceLineNo">094</span><a name="line.94"></a>
<span class="sourceLineNo">095</span>    /** A date formatter for the default locale. */<a name="line.95"></a>
<span class="sourceLineNo">096</span>    protected static final DateFormat<a name="line.96"></a>
<span class="sourceLineNo">097</span>        DATE_FORMAT_MEDIUM = DateFormat.getDateInstance(DateFormat.MEDIUM);<a name="line.97"></a>
<span class="sourceLineNo">098</span><a name="line.98"></a>
<span class="sourceLineNo">099</span>    /** A date formatter for the default locale. */<a name="line.99"></a>
<span class="sourceLineNo">100</span>    protected static final DateFormat<a name="line.100"></a>
<span class="sourceLineNo">101</span>        DATE_FORMAT_LONG = DateFormat.getDateInstance(DateFormat.LONG);<a name="line.101"></a>
<span class="sourceLineNo">102</span><a name="line.102"></a>
<span class="sourceLineNo">103</span>    /** The day (uses SerialDate for convenience). */<a name="line.103"></a>
<span class="sourceLineNo">104</span>    private SerialDate serialDate;<a name="line.104"></a>
<span class="sourceLineNo">105</span><a name="line.105"></a>
<span class="sourceLineNo">106</span>    /** The first millisecond. */<a name="line.106"></a>
<span class="sourceLineNo">107</span>    private long firstMillisecond;<a name="line.107"></a>
<span class="sourceLineNo">108</span><a name="line.108"></a>
<span class="sourceLineNo">109</span>    /** The last millisecond. */<a name="line.109"></a>
<span class="sourceLineNo">110</span>    private long lastMillisecond;<a name="line.110"></a>
<span class="sourceLineNo">111</span><a name="line.111"></a>
<span class="sourceLineNo">112</span>    /**<a name="line.112"></a>
<span class="sourceLineNo">113</span>     * Creates a new instance, derived from the system date/time (and assuming<a name="line.113"></a>
<span class="sourceLineNo">114</span>     * the default timezone).<a name="line.114"></a>
<span class="sourceLineNo">115</span>     */<a name="line.115"></a>
<span class="sourceLineNo">116</span>    public Day() {<a name="line.116"></a>
<span class="sourceLineNo">117</span>        this(new Date());<a name="line.117"></a>
<span class="sourceLineNo">118</span>    }<a name="line.118"></a>
<span class="sourceLineNo">119</span><a name="line.119"></a>
<span class="sourceLineNo">120</span>    /**<a name="line.120"></a>
<span class="sourceLineNo">121</span>     * Constructs a new one day time period.<a name="line.121"></a>
<span class="sourceLineNo">122</span>     *<a name="line.122"></a>
<span class="sourceLineNo">123</span>     * @param day  the day-of-the-month.<a name="line.123"></a>
<span class="sourceLineNo">124</span>     * @param month  the month (1 to 12).<a name="line.124"></a>
<span class="sourceLineNo">125</span>     * @param year  the year (1900 &lt;= year &lt;= 9999).<a name="line.125"></a>
<span class="sourceLineNo">126</span>     */<a name="line.126"></a>
<span class="sourceLineNo">127</span>    public Day(int day, int month, int year) {<a name="line.127"></a>
<span class="sourceLineNo">128</span>        this.serialDate = SerialDate.createInstance(day, month, year);<a name="line.128"></a>
<span class="sourceLineNo">129</span>        peg(Calendar.getInstance());<a name="line.129"></a>
<span class="sourceLineNo">130</span>    }<a name="line.130"></a>
<span class="sourceLineNo">131</span><a name="line.131"></a>
<span class="sourceLineNo">132</span>    /**<a name="line.132"></a>
<span class="sourceLineNo">133</span>     * Constructs a new one day time period.<a name="line.133"></a>
<span class="sourceLineNo">134</span>     *<a name="line.134"></a>
<span class="sourceLineNo">135</span>     * @param serialDate  the day (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.135"></a>
<span class="sourceLineNo">136</span>     */<a name="line.136"></a>
<span class="sourceLineNo">137</span>    public Day(SerialDate serialDate) {<a name="line.137"></a>
<span class="sourceLineNo">138</span>        if (serialDate == null) {<a name="line.138"></a>
<span class="sourceLineNo">139</span>            throw new IllegalArgumentException("Null 'serialDate' argument.");<a name="line.139"></a>
<span class="sourceLineNo">140</span>        }<a name="line.140"></a>
<span class="sourceLineNo">141</span>        this.serialDate = serialDate;<a name="line.141"></a>
<span class="sourceLineNo">142</span>        peg(Calendar.getInstance());<a name="line.142"></a>
<span class="sourceLineNo">143</span>    }<a name="line.143"></a>
<span class="sourceLineNo">144</span><a name="line.144"></a>
<span class="sourceLineNo">145</span>    /**<a name="line.145"></a>
<span class="sourceLineNo">146</span>     * Constructs a new instance, based on a particular date/time and the<a name="line.146"></a>
<span class="sourceLineNo">147</span>     * default time zone.<a name="line.147"></a>
<span class="sourceLineNo">148</span>     *<a name="line.148"></a>
<span class="sourceLineNo">149</span>     * @param time  the time (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.149"></a>
<span class="sourceLineNo">150</span>     *<a name="line.150"></a>
<span class="sourceLineNo">151</span>     * @see #Day(Date, TimeZone)<a name="line.151"></a>
<span class="sourceLineNo">152</span>     */<a name="line.152"></a>
<span class="sourceLineNo">153</span>    public Day(Date time) {<a name="line.153"></a>
<span class="sourceLineNo">154</span>        // defer argument checking...<a name="line.154"></a>
<span class="sourceLineNo">155</span>        this(time, TimeZone.getDefault(), Locale.getDefault());<a name="line.155"></a>
<span class="sourceLineNo">156</span>    }<a name="line.156"></a>
<span class="sourceLineNo">157</span><a name="line.157"></a>
<span class="sourceLineNo">158</span>    /**<a name="line.158"></a>
<span class="sourceLineNo">159</span>     * Constructs a new instance, based on a particular date/time and time zone.<a name="line.159"></a>
<span class="sourceLineNo">160</span>     *<a name="line.160"></a>
<span class="sourceLineNo">161</span>     * @param time  the date/time.<a name="line.161"></a>
<span class="sourceLineNo">162</span>     * @param zone  the time zone.<a name="line.162"></a>
<span class="sourceLineNo">163</span>     *<a name="line.163"></a>
<span class="sourceLineNo">164</span>     * @deprecated As of 1.0.13, use the constructor that specifies the locale<a name="line.164"></a>
<span class="sourceLineNo">165</span>     *     also.<a name="line.165"></a>
<span class="sourceLineNo">166</span>     */<a name="line.166"></a>
<span class="sourceLineNo">167</span>    public Day(Date time, TimeZone zone) {<a name="line.167"></a>
<span class="sourceLineNo">168</span>        this(time, zone, Locale.getDefault());<a name="line.168"></a>
<span class="sourceLineNo">169</span>    }<a name="line.169"></a>
<span class="sourceLineNo">170</span><a name="line.170"></a>
<span class="sourceLineNo">171</span>    /**<a name="line.171"></a>
<span class="sourceLineNo">172</span>     * Constructs a new instance, based on a particular date/time and time zone.<a name="line.172"></a>
<span class="sourceLineNo">173</span>     *<a name="line.173"></a>
<span class="sourceLineNo">174</span>     * @param time  the date/time (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.174"></a>
<span class="sourceLineNo">175</span>     * @param zone  the time zone (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.175"></a>
<span class="sourceLineNo">176</span>     * @param locale  the locale (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.176"></a>
<span class="sourceLineNo">177</span>     */<a name="line.177"></a>
<span class="sourceLineNo">178</span>    public Day(Date time, TimeZone zone, Locale locale) {<a name="line.178"></a>
<span class="sourceLineNo">179</span>        if (time == null) {<a name="line.179"></a>
<span class="sourceLineNo">180</span>            throw new IllegalArgumentException("Null 'time' argument.");<a name="line.180"></a>
<span class="sourceLineNo">181</span>        }<a name="line.181"></a>
<span class="sourceLineNo">182</span>        if (zone == null) {<a name="line.182"></a>
<span class="sourceLineNo">183</span>            throw new IllegalArgumentException("Null 'zone' argument.");<a name="line.183"></a>
<span class="sourceLineNo">184</span>        }<a name="line.184"></a>
<span class="sourceLineNo">185</span>        if (locale == null) {<a name="line.185"></a>
<span class="sourceLineNo">186</span>            throw new IllegalArgumentException("Null 'locale' argument.");<a name="line.186"></a>
<span class="sourceLineNo">187</span>        }<a name="line.187"></a>
<span class="sourceLineNo">188</span>        Calendar calendar = Calendar.getInstance(zone, locale);<a name="line.188"></a>
<span class="sourceLineNo">189</span>        calendar.setTime(time);<a name="line.189"></a>
<span class="sourceLineNo">190</span>        int d = calendar.get(Calendar.DAY_OF_MONTH);<a name="line.190"></a>
<span class="sourceLineNo">191</span>        int m = calendar.get(Calendar.MONTH) + 1;<a name="line.191"></a>
<span class="sourceLineNo">192</span>        int y = calendar.get(Calendar.YEAR);<a name="line.192"></a>
<span class="sourceLineNo">193</span>        this.serialDate = SerialDate.createInstance(d, m, y);<a name="line.193"></a>
<span class="sourceLineNo">194</span>        peg(calendar);<a name="line.194"></a>
<span class="sourceLineNo">195</span>    }<a name="line.195"></a>
<span class="sourceLineNo">196</span><a name="line.196"></a>
<span class="sourceLineNo">197</span>    /**<a name="line.197"></a>
<span class="sourceLineNo">198</span>     * Returns the day as a {@link SerialDate}.  Note: the reference that is<a name="line.198"></a>
<span class="sourceLineNo">199</span>     * returned should be an instance of an immutable {@link SerialDate}<a name="line.199"></a>
<span class="sourceLineNo">200</span>     * (otherwise the caller could use the reference to alter the state of<a name="line.200"></a>
<span class="sourceLineNo">201</span>     * this &lt;code&gt;Day&lt;/code&gt; instance, and &lt;code&gt;Day&lt;/code&gt; is supposed<a name="line.201"></a>
<span class="sourceLineNo">202</span>     * to be immutable).<a name="line.202"></a>
<span class="sourceLineNo">203</span>     *<a name="line.203"></a>
<span class="sourceLineNo">204</span>     * @return The day as a {@link SerialDate}.<a name="line.204"></a>
<span class="sourceLineNo">205</span>     */<a name="line.205"></a>
<span class="sourceLineNo">206</span>    public SerialDate getSerialDate() {<a name="line.206"></a>
<span class="sourceLineNo">207</span>        return this.serialDate;<a name="line.207"></a>
<span class="sourceLineNo">208</span>    }<a name="line.208"></a>
<span class="sourceLineNo">209</span><a name="line.209"></a>
<span class="sourceLineNo">210</span>    /**<a name="line.210"></a>
<span class="sourceLineNo">211</span>     * Returns the year.<a name="line.211"></a>
<span class="sourceLineNo">212</span>     *<a name="line.212"></a>
<span class="sourceLineNo">213</span>     * @return The year.<a name="line.213"></a>
<span class="sourceLineNo">214</span>     */<a name="line.214"></a>
<span class="sourceLineNo">215</span>    public int getYear() {<a name="line.215"></a>
<span class="sourceLineNo">216</span>        return this.serialDate.getYYYY();<a name="line.216"></a>
<span class="sourceLineNo">217</span>    }<a name="line.217"></a>
<span class="sourceLineNo">218</span><a name="line.218"></a>
<span class="sourceLineNo">219</span>    /**<a name="line.219"></a>
<span class="sourceLineNo">220</span>     * Returns the month.<a name="line.220"></a>
<span class="sourceLineNo">221</span>     *<a name="line.221"></a>
<span class="sourceLineNo">222</span>     * @return The month.<a name="line.222"></a>
<span class="sourceLineNo">223</span>     */<a name="line.223"></a>
<span class="sourceLineNo">224</span>    public int getMonth() {<a name="line.224"></a>
<span class="sourceLineNo">225</span>        return this.serialDate.getMonth();<a name="line.225"></a>
<span class="sourceLineNo">226</span>    }<a name="line.226"></a>
<span class="sourceLineNo">227</span><a name="line.227"></a>
<span class="sourceLineNo">228</span>    /**<a name="line.228"></a>
<span class="sourceLineNo">229</span>     * Returns the day of the month.<a name="line.229"></a>
<span class="sourceLineNo">230</span>     *<a name="line.230"></a>
<span class="sourceLineNo">231</span>     * @return The day of the month.<a name="line.231"></a>
<span class="sourceLineNo">232</span>     */<a name="line.232"></a>
<span class="sourceLineNo">233</span>    public int getDayOfMonth() {<a name="line.233"></a>
<span class="sourceLineNo">234</span>        return this.serialDate.getDayOfMonth();<a name="line.234"></a>
<span class="sourceLineNo">235</span>    }<a name="line.235"></a>
<span class="sourceLineNo">236</span><a name="line.236"></a>
<span class="sourceLineNo">237</span>    /**<a name="line.237"></a>
<span class="sourceLineNo">238</span>     * Returns the first millisecond of the day.  This will be determined<a name="line.238"></a>
<span class="sourceLineNo">239</span>     * relative to the time zone specified in the constructor, or in the<a name="line.239"></a>
<span class="sourceLineNo">240</span>     * calendar instance passed in the most recent call to the<a name="line.240"></a>
<span class="sourceLineNo">241</span>     * {@link #peg(Calendar)} method.<a name="line.241"></a>
<span class="sourceLineNo">242</span>     *<a name="line.242"></a>
<span class="sourceLineNo">243</span>     * @return The first millisecond of the day.<a name="line.243"></a>
<span class="sourceLineNo">244</span>     *<a name="line.244"></a>
<span class="sourceLineNo">245</span>     * @see #getLastMillisecond()<a name="line.245"></a>
<span class="sourceLineNo">246</span>     */<a name="line.246"></a>
<span class="sourceLineNo">247</span>    public long getFirstMillisecond() {<a name="line.247"></a>
<span class="sourceLineNo">248</span>        return this.firstMillisecond;<a name="line.248"></a>
<span class="sourceLineNo">249</span>    }<a name="line.249"></a>
<span class="sourceLineNo">250</span><a name="line.250"></a>
<span class="sourceLineNo">251</span>    /**<a name="line.251"></a>
<span class="sourceLineNo">252</span>     * Returns the last millisecond of the day.  This will be<a name="line.252"></a>
<span class="sourceLineNo">253</span>     * determined relative to the time zone specified in the constructor, or<a name="line.253"></a>
<span class="sourceLineNo">254</span>     * in the calendar instance passed in the most recent call to the<a name="line.254"></a>
<span class="sourceLineNo">255</span>     * {@link #peg(Calendar)} method.<a name="line.255"></a>
<span class="sourceLineNo">256</span>     *<a name="line.256"></a>
<span class="sourceLineNo">257</span>     * @return The last millisecond of the day.<a name="line.257"></a>
<span class="sourceLineNo">258</span>     *<a name="line.258"></a>
<span class="sourceLineNo">259</span>     * @see #getFirstMillisecond()<a name="line.259"></a>
<span class="sourceLineNo">260</span>     */<a name="line.260"></a>
<span class="sourceLineNo">261</span>    public long getLastMillisecond() {<a name="line.261"></a>
<span class="sourceLineNo">262</span>        return this.lastMillisecond;<a name="line.262"></a>
<span class="sourceLineNo">263</span>    }<a name="line.263"></a>
<span class="sourceLineNo">264</span><a name="line.264"></a>
<span class="sourceLineNo">265</span>    /**<a name="line.265"></a>
<span class="sourceLineNo">266</span>     * Recalculates the start date/time and end date/time for this time period<a name="line.266"></a>
<span class="sourceLineNo">267</span>     * relative to the supplied calendar (which incorporates a time zone).<a name="line.267"></a>
<span class="sourceLineNo">268</span>     *<a name="line.268"></a>
<span class="sourceLineNo">269</span>     * @param calendar  the calendar (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.269"></a>
<span class="sourceLineNo">270</span>     *<a name="line.270"></a>
<span class="sourceLineNo">271</span>     * @since 1.0.3<a name="line.271"></a>
<span class="sourceLineNo">272</span>     */<a name="line.272"></a>
<span class="sourceLineNo">273</span>    public void peg(Calendar calendar) {<a name="line.273"></a>
<span class="sourceLineNo">274</span>        this.firstMillisecond = getFirstMillisecond(calendar);<a name="line.274"></a>
<span class="sourceLineNo">275</span>        this.lastMillisecond = getLastMillisecond(calendar);<a name="line.275"></a>
<span class="sourceLineNo">276</span>    }<a name="line.276"></a>
<span class="sourceLineNo">277</span><a name="line.277"></a>
<span class="sourceLineNo">278</span>    /**<a name="line.278"></a>
<span class="sourceLineNo">279</span>     * Returns the day preceding this one.<a name="line.279"></a>
<span class="sourceLineNo">280</span>     *<a name="line.280"></a>
<span class="sourceLineNo">281</span>     * @return The day preceding this one.<a name="line.281"></a>
<span class="sourceLineNo">282</span>     */<a name="line.282"></a>
<span class="sourceLineNo">283</span>    public RegularTimePeriod previous() {<a name="line.283"></a>
<span class="sourceLineNo">284</span>        Day result;<a name="line.284"></a>
<span class="sourceLineNo">285</span>        int serial = this.serialDate.toSerial();<a name="line.285"></a>
<span class="sourceLineNo">286</span>        if (serial &gt; SerialDate.SERIAL_LOWER_BOUND) {<a name="line.286"></a>
<span class="sourceLineNo">287</span>            SerialDate yesterday = SerialDate.createInstance(serial - 1);<a name="line.287"></a>
<span class="sourceLineNo">288</span>            return new Day(yesterday);<a name="line.288"></a>
<span class="sourceLineNo">289</span>        }<a name="line.289"></a>
<span class="sourceLineNo">290</span>        else {<a name="line.290"></a>
<span class="sourceLineNo">291</span>            result = null;<a name="line.291"></a>
<span class="sourceLineNo">292</span>        }<a name="line.292"></a>
<span class="sourceLineNo">293</span>        return result;<a name="line.293"></a>
<span class="sourceLineNo">294</span>    }<a name="line.294"></a>
<span class="sourceLineNo">295</span><a name="line.295"></a>
<span class="sourceLineNo">296</span>    /**<a name="line.296"></a>
<span class="sourceLineNo">297</span>     * Returns the day following this one, or &lt;code&gt;null&lt;/code&gt; if some limit<a name="line.297"></a>
<span class="sourceLineNo">298</span>     * has been reached.<a name="line.298"></a>
<span class="sourceLineNo">299</span>     *<a name="line.299"></a>
<span class="sourceLineNo">300</span>     * @return The day following this one, or &lt;code&gt;null&lt;/code&gt; if some limit<a name="line.300"></a>
<span class="sourceLineNo">301</span>     *         has been reached.<a name="line.301"></a>
<span class="sourceLineNo">302</span>     */<a name="line.302"></a>
<span class="sourceLineNo">303</span>    public RegularTimePeriod next() {<a name="line.303"></a>
<span class="sourceLineNo">304</span>        Day result;<a name="line.304"></a>
<span class="sourceLineNo">305</span>        int serial = this.serialDate.toSerial();<a name="line.305"></a>
<span class="sourceLineNo">306</span>        if (serial &lt; SerialDate.SERIAL_UPPER_BOUND) {<a name="line.306"></a>
<span class="sourceLineNo">307</span>            SerialDate tomorrow = SerialDate.createInstance(serial + 1);<a name="line.307"></a>
<span class="sourceLineNo">308</span>            return new Day(tomorrow);<a name="line.308"></a>
<span class="sourceLineNo">309</span>        }<a name="line.309"></a>
<span class="sourceLineNo">310</span>        else {<a name="line.310"></a>
<span class="sourceLineNo">311</span>            result = null;<a name="line.311"></a>
<span class="sourceLineNo">312</span>        }<a name="line.312"></a>
<span class="sourceLineNo">313</span>        return result;<a name="line.313"></a>
<span class="sourceLineNo">314</span>    }<a name="line.314"></a>
<span class="sourceLineNo">315</span><a name="line.315"></a>
<span class="sourceLineNo">316</span>    /**<a name="line.316"></a>
<span class="sourceLineNo">317</span>     * Returns a serial index number for the day.<a name="line.317"></a>
<span class="sourceLineNo">318</span>     *<a name="line.318"></a>
<span class="sourceLineNo">319</span>     * @return The serial index number.<a name="line.319"></a>
<span class="sourceLineNo">320</span>     */<a name="line.320"></a>
<span class="sourceLineNo">321</span>    public long getSerialIndex() {<a name="line.321"></a>
<span class="sourceLineNo">322</span>        return this.serialDate.toSerial();<a name="line.322"></a>
<span class="sourceLineNo">323</span>    }<a name="line.323"></a>
<span class="sourceLineNo">324</span><a name="line.324"></a>
<span class="sourceLineNo">325</span>    /**<a name="line.325"></a>
<span class="sourceLineNo">326</span>     * Returns the first millisecond of the day, evaluated using the supplied<a name="line.326"></a>
<span class="sourceLineNo">327</span>     * calendar (which determines the time zone).<a name="line.327"></a>
<span class="sourceLineNo">328</span>     *<a name="line.328"></a>
<span class="sourceLineNo">329</span>     * @param calendar  calendar to use (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.329"></a>
<span class="sourceLineNo">330</span>     *<a name="line.330"></a>
<span class="sourceLineNo">331</span>     * @return The start of the day as milliseconds since 01-01-1970.<a name="line.331"></a>
<span class="sourceLineNo">332</span>     *<a name="line.332"></a>
<span class="sourceLineNo">333</span>     * @throws NullPointerException if &lt;code&gt;calendar&lt;/code&gt; is<a name="line.333"></a>
<span class="sourceLineNo">334</span>     *     &lt;code&gt;null&lt;/code&gt;.<a name="line.334"></a>
<span class="sourceLineNo">335</span>     */<a name="line.335"></a>
<span class="sourceLineNo">336</span>    public long getFirstMillisecond(Calendar calendar) {<a name="line.336"></a>
<span class="sourceLineNo">337</span>        int year = this.serialDate.getYYYY();<a name="line.337"></a>
<span class="sourceLineNo">338</span>        int month = this.serialDate.getMonth();<a name="line.338"></a>
<span class="sourceLineNo">339</span>        int day = this.serialDate.getDayOfMonth();<a name="line.339"></a>
<span class="sourceLineNo">340</span>        calendar.clear();<a name="line.340"></a>
<span class="sourceLineNo">341</span>        calendar.set(year, month - 1, day, 0, 0, 0);<a name="line.341"></a>
<span class="sourceLineNo">342</span>        calendar.set(Calendar.MILLISECOND, 0);<a name="line.342"></a>
<span class="sourceLineNo">343</span>        //return calendar.getTimeInMillis();  // this won't work for JDK 1.3<a name="line.343"></a>
<span class="sourceLineNo">344</span>        return calendar.getTime().getTime();<a name="line.344"></a>
<span class="sourceLineNo">345</span>    }<a name="line.345"></a>
<span class="sourceLineNo">346</span><a name="line.346"></a>
<span class="sourceLineNo">347</span>    /**<a name="line.347"></a>
<span class="sourceLineNo">348</span>     * Returns the last millisecond of the day, evaluated using the supplied<a name="line.348"></a>
<span class="sourceLineNo">349</span>     * calendar (which determines the time zone).<a name="line.349"></a>
<span class="sourceLineNo">350</span>     *<a name="line.350"></a>
<span class="sourceLineNo">351</span>     * @param calendar  calendar to use (&lt;code&gt;null&lt;/code&gt; not permitted).<a name="line.351"></a>
<span class="sourceLineNo">352</span>     *<a name="line.352"></a>
<span class="sourceLineNo">353</span>     * @return The end of the day as milliseconds since 01-01-1970.<a name="line.353"></a>
<span class="sourceLineNo">354</span>     *<a name="line.354"></a>
<span class="sourceLineNo">355</span>     * @throws NullPointerException if &lt;code&gt;calendar&lt;/code&gt; is<a name="line.355"></a>
<span class="sourceLineNo">356</span>     *     &lt;code&gt;null&lt;/code&gt;.<a name="line.356"></a>
<span class="sourceLineNo">357</span>     */<a name="line.357"></a>
<span class="sourceLineNo">358</span>    public long getLastMillisecond(Calendar calendar) {<a name="line.358"></a>
<span class="sourceLineNo">359</span>        int year = this.serialDate.getYYYY();<a name="line.359"></a>
<span class="sourceLineNo">360</span>        int month = this.serialDate.getMonth();<a name="line.360"></a>
<span class="sourceLineNo">361</span>        int day = this.serialDate.getDayOfMonth();<a name="line.361"></a>
<span class="sourceLineNo">362</span>        calendar.clear();<a name="line.362"></a>
<span class="sourceLineNo">363</span>        calendar.set(year, month - 1, day, 23, 59, 59);<a name="line.363"></a>
<span class="sourceLineNo">364</span>        calendar.set(Calendar.MILLISECOND, 999);<a name="line.364"></a>
<span class="sourceLineNo">365</span>        //return calendar.getTimeInMillis();  // this won't work for JDK 1.3<a name="line.365"></a>
<span class="sourceLineNo">366</span>        return calendar.getTime().getTime();<a name="line.366"></a>
<span class="sourceLineNo">367</span>    }<a name="line.367"></a>
<span class="sourceLineNo">368</span><a name="line.368"></a>
<span class="sourceLineNo">369</span>    /**<a name="line.369"></a>
<span class="sourceLineNo">370</span>     * Tests the equality of this Day object to an arbitrary object.  Returns<a name="line.370"></a>
<span class="sourceLineNo">371</span>     * true if the target is a Day instance or a SerialDate instance<a name="line.371"></a>
<span class="sourceLineNo">372</span>     * representing the same day as this object. In all other cases,<a name="line.372"></a>
<span class="sourceLineNo">373</span>     * returns false.<a name="line.373"></a>
<span class="sourceLineNo">374</span>     *<a name="line.374"></a>
<span class="sourceLineNo">375</span>     * @param obj  the object (&lt;code&gt;null&lt;/code&gt; permitted).<a name="line.375"></a>
<span class="sourceLineNo">376</span>     *<a name="line.376"></a>
<span class="sourceLineNo">377</span>     * @return A flag indicating whether or not an object is equal to this day.<a name="line.377"></a>
<span class="sourceLineNo">378</span>     */<a name="line.378"></a>
<span class="sourceLineNo">379</span>    public boolean equals(Object obj) {<a name="line.379"></a>
<span class="sourceLineNo">380</span>        if (obj == this) {<a name="line.380"></a>
<span class="sourceLineNo">381</span>            return true;<a name="line.381"></a>
<span class="sourceLineNo">382</span>        }<a name="line.382"></a>
<span class="sourceLineNo">383</span>        if (!(obj instanceof Day)) {<a name="line.383"></a>
<span class="sourceLineNo">384</span>            return false;<a name="line.384"></a>
<span class="sourceLineNo">385</span>        }<a name="line.385"></a>
<span class="sourceLineNo">386</span>        Day that = (Day) obj;<a name="line.386"></a>
<span class="sourceLineNo">387</span>        if (!this.serialDate.equals(that.getSerialDate())) {<a name="line.387"></a>
<span class="sourceLineNo">388</span>            return false;<a name="line.388"></a>
<span class="sourceLineNo">389</span>        }<a name="line.389"></a>
<span class="sourceLineNo">390</span>        return true;<a name="line.390"></a>
<span class="sourceLineNo">391</span>    }<a name="line.391"></a>
<span class="sourceLineNo">392</span><a name="line.392"></a>
<span class="sourceLineNo">393</span>    /**<a name="line.393"></a>
<span class="sourceLineNo">394</span>     * Returns a hash code for this object instance.  The approach described by<a name="line.394"></a>
<span class="sourceLineNo">395</span>     * Joshua Bloch in "Effective Java" has been used here:<a name="line.395"></a>
<span class="sourceLineNo">396</span>     * &lt;p&gt;<a name="line.396"></a>
<span class="sourceLineNo">397</span>     * &lt;code&gt;http://developer.java.sun.com/developer/Books/effectivejava<a name="line.397"></a>
<span class="sourceLineNo">398</span>     * /Chapter3.pdf&lt;/code&gt;<a name="line.398"></a>
<span class="sourceLineNo">399</span>     *<a name="line.399"></a>
<span class="sourceLineNo">400</span>     * @return A hash code.<a name="line.400"></a>
<span class="sourceLineNo">401</span>     */<a name="line.401"></a>
<span class="sourceLineNo">402</span>    public int hashCode() {<a name="line.402"></a>
<span class="sourceLineNo">403</span>        return this.serialDate.hashCode();<a name="line.403"></a>
<span class="sourceLineNo">404</span>    }<a name="line.404"></a>
<span class="sourceLineNo">405</span><a name="line.405"></a>
<span class="sourceLineNo">406</span>    /**<a name="line.406"></a>
<span class="sourceLineNo">407</span>     * Returns an integer indicating the order of this Day object relative to<a name="line.407"></a>
<span class="sourceLineNo">408</span>     * the specified object:<a name="line.408"></a>
<span class="sourceLineNo">409</span>     *<a name="line.409"></a>
<span class="sourceLineNo">410</span>     * negative == before, zero == same, positive == after.<a name="line.410"></a>
<span class="sourceLineNo">411</span>     *<a name="line.411"></a>
<span class="sourceLineNo">412</span>     * @param o1  the object to compare.<a name="line.412"></a>
<span class="sourceLineNo">413</span>     *<a name="line.413"></a>
<span class="sourceLineNo">414</span>     * @return negative == before, zero == same, positive == after.<a name="line.414"></a>
<span class="sourceLineNo">415</span>     */<a name="line.415"></a>
<span class="sourceLineNo">416</span>    public int compareTo(Object o1) {<a name="line.416"></a>
<span class="sourceLineNo">417</span>        int result;<a name="line.417"></a>
<span class="sourceLineNo">418</span><a name="line.418"></a>
<span class="sourceLineNo">419</span>        // CASE 1 : Comparing to another Day object<a name="line.419"></a>
<span class="sourceLineNo">420</span>        // ----------------------------------------<a name="line.420"></a>
<span class="sourceLineNo">421</span>        if (o1 instanceof Day) {<a name="line.421"></a>
<span class="sourceLineNo">422</span>            Day d = (Day) o1;<a name="line.422"></a>
<span class="sourceLineNo">423</span>            result = -d.getSerialDate().compare(this.serialDate);<a name="line.423"></a>
<span class="sourceLineNo">424</span>        }<a name="line.424"></a>
<span class="sourceLineNo">425</span><a name="line.425"></a>
<span class="sourceLineNo">426</span>        // CASE 2 : Comparing to another TimePeriod object<a name="line.426"></a>
<span class="sourceLineNo">427</span>        // -----------------------------------------------<a name="line.427"></a>
<span class="sourceLineNo">428</span>        else if (o1 instanceof RegularTimePeriod) {<a name="line.428"></a>
<span class="sourceLineNo">429</span>            // more difficult case - evaluate later...<a name="line.429"></a>
<span class="sourceLineNo">430</span>            result = 0;<a name="line.430"></a>
<span class="sourceLineNo">431</span>        }<a name="line.431"></a>
<span class="sourceLineNo">432</span><a name="line.432"></a>
<span class="sourceLineNo">433</span>        // CASE 3 : Comparing to a non-TimePeriod object<a name="line.433"></a>
<span class="sourceLineNo">434</span>        // ---------------------------------------------<a name="line.434"></a>
<span class="sourceLineNo">435</span>        else {<a name="line.435"></a>
<span class="sourceLineNo">436</span>            // consider time periods to be ordered after general objects<a name="line.436"></a>
<span class="sourceLineNo">437</span>            result = 1;<a name="line.437"></a>
<span class="sourceLineNo">438</span>        }<a name="line.438"></a>
<span class="sourceLineNo">439</span><a name="line.439"></a>
<span class="sourceLineNo">440</span>        return result;<a name="line.440"></a>
<span class="sourceLineNo">441</span>    }<a name="line.441"></a>
<span class="sourceLineNo">442</span><a name="line.442"></a>
<span class="sourceLineNo">443</span>    /**<a name="line.443"></a>
<span class="sourceLineNo">444</span>     * Returns a string representing the day.<a name="line.444"></a>
<span class="sourceLineNo">445</span>     *<a name="line.445"></a>
<span class="sourceLineNo">446</span>     * @return A string representing the day.<a name="line.446"></a>
<span class="sourceLineNo">447</span>     */<a name="line.447"></a>
<span class="sourceLineNo">448</span>    public String toString() {<a name="line.448"></a>
<span class="sourceLineNo">449</span>        return this.serialDate.toString();<a name="line.449"></a>
<span class="sourceLineNo">450</span>    }<a name="line.450"></a>
<span class="sourceLineNo">451</span><a name="line.451"></a>
<span class="sourceLineNo">452</span>    /**<a name="line.452"></a>
<span class="sourceLineNo">453</span>     * Parses the string argument as a day.<a name="line.453"></a>
<span class="sourceLineNo">454</span>     * &lt;P&gt;<a name="line.454"></a>
<span class="sourceLineNo">455</span>     * This method is required to recognise YYYY-MM-DD as a valid format.<a name="line.455"></a>
<span class="sourceLineNo">456</span>     * Anything else, for now, is a bonus.<a name="line.456"></a>
<span class="sourceLineNo">457</span>     *<a name="line.457"></a>
<span class="sourceLineNo">458</span>     * @param s  the date string to parse.<a name="line.458"></a>
<span class="sourceLineNo">459</span>     *<a name="line.459"></a>
<span class="sourceLineNo">460</span>     * @return &lt;code&gt;null&lt;/code&gt; if the string does not contain any parseable<a name="line.460"></a>
<span class="sourceLineNo">461</span>     *      string, the day otherwise.<a name="line.461"></a>
<span class="sourceLineNo">462</span>     */<a name="line.462"></a>
<span class="sourceLineNo">463</span>    public static Day parseDay(String s) {<a name="line.463"></a>
<span class="sourceLineNo">464</span>        try {<a name="line.464"></a>
<span class="sourceLineNo">465</span>            return new Day (Day.DATE_FORMAT.parse(s));<a name="line.465"></a>
<span class="sourceLineNo">466</span>        }<a name="line.466"></a>
<span class="sourceLineNo">467</span>        catch (ParseException e1) {<a name="line.467"></a>
<span class="sourceLineNo">468</span>            try {<a name="line.468"></a>
<span class="sourceLineNo">469</span>                return new Day (Day.DATE_FORMAT_SHORT.parse(s));<a name="line.469"></a>
<span class="sourceLineNo">470</span>            }<a name="line.470"></a>
<span class="sourceLineNo">471</span>            catch (ParseException e2) {<a name="line.471"></a>
<span class="sourceLineNo">472</span>              // ignore<a name="line.472"></a>
<span class="sourceLineNo">473</span>            }<a name="line.473"></a>
<span class="sourceLineNo">474</span>        }<a name="line.474"></a>
<span class="sourceLineNo">475</span>        return null;<a name="line.475"></a>
<span class="sourceLineNo">476</span>    }<a name="line.476"></a>
<span class="sourceLineNo">477</span><a name="line.477"></a>
<span class="sourceLineNo">478</span>}<a name="line.478"></a>




























































</pre>
</div>
</body>
</html>
